Skip to content

Conversation

@danpastori
Copy link
Contributor

@danpastori danpastori commented Oct 17, 2025

A Complete Overhaul of the documentation

This PR updates the documentation to use the latest and greatest Nuxt along with Nuxt UI for standardized development. Included in this PR:

  • Nuxt 4 Upgrade
  • Nuxt Content v3 Upgrade
  • Nuxt UI
  • Utilize the base Nuxt UI Docs template so contributors have better documentation

Remaining Items

Homepage

  • "Dev -> Prod"
  • Testimonials
  • Newsletter sign up form
  • "PHP Is Dead"

Layout

  • Server Side Up Banner on top

Nest the documentation under /docs

  • Ensure the URL for docs is prefixed with /docs

SEO

  • Bring over OG Image
  • Ensure Sitemap works
  • Ensure Structured data is set up
  • Connect analytics

Documentation

Most of the documentation needs to be migrated. I didn't do all of this because it's going to be heavily updated. Here are some of the documentation migration notes:

Updated Front Matter

The front matter is the YAML that is on the markdown pages. The new format is:

---
title: Installation
description: Learn how to get started with serversideup/php Docker Images.
navigation:
  icon: i-lucide-download
---

The big difference is we have icons before the documentation. You can find all icons here: https://lucide.dev/icons/. To add the icon it's i-lucide-{name found on site}. The docs does use Iconify so there could be other providers as well. Lucide fits really nice with the docs though.

Migrating Code Embeds

@jaydrogers The biggest thing you will have to update in the documentation is the code embeds. We are using: https://ui.nuxt.com/docs/typography/code#filename. There's also code group: https://ui.nuxt.com/docs/typography/code-group

What you will have to do is remove all ::code-panel components within the docs and update to the new format. There is no label so you will have to use an h3 tag to label if needed. The new format allows you to set filename though. For an example, check out /docs/content/1.getting-started/3.installation.md. I have an example in there.

LLM Data

@jaydrogers We will need to fill out the LLM Data for the docs: https://nuxt.com/modules/llms. This is a new feature that allows you to help LLMs find what they need in your documentation.

It'd also be helpful to provide some sample LLM documentation: https://reka-ui.com/docs/overview/getting-started#example-prompts

@danpastori danpastori self-assigned this Oct 17, 2025
@danpastori danpastori added the 📝 Documentation Items that relate to documentation improvements. label Oct 17, 2025
@danpastori danpastori marked this pull request as draft October 17, 2025 15:11
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 19, 2025

Deploying serversideup-php with  Cloudflare Pages  Cloudflare Pages

Latest commit: bfd396b
Status: ✅  Deploy successful!
Preview URL: https://1cf9d0d3.serversideup-php.pages.dev
Branch Preview URL: https://feature-280-pr-docs-update.serversideup-php.pages.dev

View logs

jaydrogers and others added 24 commits October 20, 2025 09:37
…EADME for clarity. Refactor app components and CSS for improved styling and structure.
…docs-update

# Conflicts:
#	docs/content/1.getting-started/3.installation.md
…FPM-NGINX, and FrankenPHP variations. Marked NGINX Unit as deprecated and provided migration guidance. Improved overall structure for better user understanding.
…documentation pages to streamline content presentation.
…se of Nuxt UI and providing a link to the Nuxt UI Documentation Template.
… clarity, removing outdated sections and adding a callout for Docker compatibility.
… "batteries included" approach for improved developer experience.
jaydrogers and others added 27 commits October 31, 2025 14:04
…concepts of images vs containers, image layers, volumes, ports, environment variables, and the container lifecycle. This update enhances user understanding of Docker and prepares them for deploying applications from development to production.
…image version 8.3 to 8.4, and clarify the container stopping behavior. Additionally, enhance the environment variable tip with a direct link to the specification for better user guidance.
…iling the transition from development to production images, creating Dockerfiles, best practices, and image versioning strategies. This guide aims to enhance user understanding of building secure and reliable Docker images for production environments.
…se 'compose.yml' for consistency across task scheduler, queue, horizon, and reverb guides.
…' to 'compose.yml' for consistency in configuration examples.
…mpose.yml' instead of 'docker-compose.yml' across all examples.
…addressing common challenges and providing solutions for managing UID/GID alignment between host and container environments. This guide includes examples for development and production setups to enhance user experience and security.
…larity on user and permission management in development environments. Updated image path syntax for consistency and enhanced user understanding of file permission challenges across different operating systems.
…' with 'compose.yml' for consistency across examples.
…on using Docker. Covers deployment challenges, Docker benefits, production image building, deployment strategies, automation, and introduces Spin for simplified workflows. Aims to enhance user confidence in deploying PHP applications.
…yml' for consistency in configuration examples and improve clarity in Docker setup instructions.
…cludes requirements, execution order, and examples for integrating scripts into the entrypoint.d directory, as well as guidance on using S6 Overlay for long-running services.
…s examples for using environment variables and custom php.ini files, along with validation methods to ensure changes are applied correctly.
…roduced icons for DigitalOcean, Hetzner, Vultr, and Sevalla, enhancing visual representation of hosting options in the application.
…ntainerized PHP applications. The guide covers portability, hosting options, recommended hosts, and key considerations for selecting the right host, enhancing user understanding of deployment strategies.
…documentation. Include a link to the guide on using healthchecks with Laravel for better user guidance.
…C_PATH` with `CADDY_SERVER_ROOT` for clarity and consistency. Adjust Caddyfile configuration to reflect the new variable, ensuring accurate root directory settings for the Caddy server.
…ER_ROOT` for improved clarity in server configuration.
…erversideup/php image. This includes usage guidelines, feature comparisons, setup instructions, and environment variable configurations, aimed at enhancing user understanding and adoption of this modern PHP application server.
…ng setup instructions, health check implementation, and performance considerations. Introduce a health check script for Octane to ensure proper application status monitoring.
…proved navigation. Adjusted paths to ensure they are correctly formatted for internal referencing.
…sure users are properly redirected when a page has a redirect property. This change enhances user experience by maintaining expected navigation behavior.
…the `SSL_PRIVATE_KEY_FILE` entry, enhancing clarity on supported configurations for HTTPS.
@jaydrogers jaydrogers merged commit bfd396b into 280-create-a-frankenphp-variation Nov 4, 2025
2 of 87 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in serversideup/php v4.0 Nov 4, 2025
@jaydrogers jaydrogers deleted the feature/280-pr-docs-update branch November 4, 2025 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📝 Documentation Items that relate to documentation improvements.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants